<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../print.css" type="text/css" media="print">
<meta content="Paprika,jp.raohmaru.motion.Paprika,add,getSpice,isSpice,remove,stop,wait" name="keywords">
<title>jp.raohmaru.motion.Paprika</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'Paprika - Raohmaru AS3 Framework';
				var baseRef = '../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">Raohmaru AS3 

Framework</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../index-list.html')" href="../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../index.html?jp/raohmaru/motion/Paprika.html&amp;jp/raohmaru/motion/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;Paprika</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class Paprika"); titleBar_setSubNav(false,false,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">jp.raohmaru.motion</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class Paprika</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">Paprika <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> flash.events.EventDispatcher</td>
</tr>
</table>
<p></p>
 Otra librería de movimiento más, pero esta a mi gusto. ¡Paprika!<br>
 El propósito es crear una clase básica ligera y muy rápida, con únicamente los métodos más utilizados en el desarrollo web. Para animaciones
 más complejas o con efectos ya están las otras.<br>
 Utiliza una reserva de objetos (object pool) de saco roto para optimizar el rendimiento.<br>
 Esta inspirada (y a veces basada) en las tres grandes librerías de movimiento en AS3: caurina.Tweener, TweenMax y Tweensy.
 <p></p>
<br>
<span class="label">Example</span>
<br><div class='listing'><pre>
import jp.raohmaru.motion.Paprika;
import jp.raohmaru.motion.easing.Quad;<br>
Paprika.add(some_mc, .5, {x:100, y:200, rotation:15}, Quad.easeInOut, 0, onComplete, [some_mc]);

function onComplete(some_mc :DisplayObject) :void
{
 // ...
}</pre></div>
 <p></p>
<br>
<hr>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#add()">add</a>(target:Object, time:Number, props:Object, ease:Function = null, delay:Number = 0, onComplete:Function = null, onCompleteParams:Array = null, scope:Object = null):<a href="../motion/PaprikaSpice.html">PaprikaSpice</a>
</div>
<div class="summaryTableDescription">[static]
  Añade una nueva especia a la lista de objetos de la animación.</div>
</td><td class="summaryTableOwnerCol">Paprika</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getSpice()">getSpice</a>(target:Object):<a href="../motion/PaprikaSpice.html">PaprikaSpice</a>
</div>
<div class="summaryTableDescription">[static]
  Obtiene la instancia de PaprikaSpice asociada al objeto especificado.</div>
</td><td class="summaryTableOwnerCol">Paprika</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#isSpice()">isSpice</a>(target:Object):Boolean</div>
<div class="summaryTableDescription">[static]
  Comprueba si el objeto especificado tiene una animación creada con Paprika.</div>
</td><td class="summaryTableOwnerCol">Paprika</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#remove()">remove</a>(target:Object):void</div>
<div class="summaryTableDescription">[static]
  Elimina y detiene la animación de una una especia de la lista de objetos interna.</div>
</td><td class="summaryTableOwnerCol">Paprika</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#stop()">stop</a>():void</div>
<div class="summaryTableDescription">[static]
  Detiene todas las interpolaciones que se están ejecutando, eliminándolas de la lista de ejecución interna.</div>
</td><td class="summaryTableOwnerCol">Paprika</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#wait()">wait</a>(target:Object, time:Number, delay:Number = 0, onComplete:Function = null, onCompleteParams:Array = null, scope:Object = null):<a href="../motion/PaprikaSpice.html">PaprikaSpice</a>
</div>
<div class="summaryTableDescription">[static]
  Añade una especia con temporizador.</div>
</td><td class="summaryTableOwnerCol">Paprika</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="add()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">add</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public static function add(target:Object, time:Number, props:Object, ease:Function = null, delay:Number = 0, onComplete:Function = null, onCompleteParams:Array = null, scope:Object = null):<a href="../motion/PaprikaSpice.html">PaprikaSpice</a></code><p>
  Añade una nueva especia a la lista de objetos de la animación. Si el objeto ya existe, se sustituirá en el caso que se sobreescriba una propiedad
  de dicho objeto que esté siendo animada, a menos que la animación empieza con retraso (<code>delay</code>);
  </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">target</span>:Object</code> &mdash; Un objeto cuyas propiedades serán interpoladas.
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">time</span>:Number</code> &mdash; La duración de la animación, en segundos o fotogramas. Para poder utilizar un valor en fotogramas, el atributo
  <code>PaprikaSpice.useFrames</code> se ha de establecer en <code>true</code>.
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">props</span>:Object</code> &mdash; Un objeto con los valores finales de las propiedades del objeto que serán interpoladas. Acepta cualquier tipo de propiedad que tenga
  el objeto de destino. Existen también estas propiedas especiales:
  <ul><li><b>autoAlpha</b>: Modifica las propiedades <code>alpha</code> y <code>visible</code> del objeto, mostrándolo si <code>visible=false</code>
  y el valor de <code>autoAlpha</code> es superior a <code>0</code>, o ocultándolo si el valor es <code>0</code> al finalizar la animación.</li>
  <li><b>scale</b>: Modifica las propiedades <code>scaleX</code> y <code>scaleY</code> a la vez.</li>
  <li><b>color</b>: Cambia el color del objeto, modificando su propiedad <code>transform.colorTransform</code>.</li>
  <li><b>colorTint</b>: Porcentaje que se aplica al color de la tinta, expresado como valor decimal entre 0 y 1.</li>
  <li><b>brightness</b>: Porcentaje de brillo, expresado como número decimal entre -1 y 1. Los valores positivos iluminan el objeto y un valor de 1
  convierte el objeto en un objeto totalmente blanco. Los valores negativos oscurecen el objeto y un valor de -1 convierte el objeto en un objeto
  totalmente negro.</li>
  <li><b>contrast</b>: Cantidad de contraste a aplicar. Los valores van desde -1 (sin contrase), 0 (normal) a 1 (muy contrastado).</li></ul>
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">ease</span>:Function</code> (default = <code>null</code>)<code></code> &mdash; La ecuación de movimiento a utilizar en la interpolación. Están incluidas en la librería en el paquete jp.raohmaru.motion.easing.
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">delay</span>:Number</code> (default = <code>0</code>)<code></code> &mdash; Cantidad de retraso en segundos o fotogramas hasta que se inicia la animación. Si es superior a 0 no se sobrescribirá la interpolación.
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">onComplete</span>:Function</code> (default = <code>null</code>)<code></code> &mdash; Método que será invocado al finalizar la animación.
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">onCompleteParams</span>:Array</code> (default = <code>null</code>)<code></code> &mdash; Matriz con los parámetros a enviar a la función definida en <code>onComplete</code>.
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">scope</span>:Object</code> (default = <code>null</code>)<code></code> &mdash; Objeto al que se aplica la función definida en <code>onComplete</code>. Si no se especifica, se usará <code>target</code>.
  </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../motion/PaprikaSpice.html">PaprikaSpice</a></code> &mdash; 
                        Una instancia de la clase PaprikaSpice con los parámetros de la interpolación.
  
                        
                     </td>
</tr>
</table>
<br>
<span class="label">Example</span>
<br><div class='listing'><pre>import jp.raohmaru.motion.Paprika;
import jp.raohmaru.motion.easing.Quad;<br>
Paprika.add(some_mc, .5, {x:100, y:200, scale:1.2}, Quad.easeInOut);
var spice :PaprikaSpice = Paprika.add(some_mc, .5, {x:100, y:200, color:0xFFCC00}, Quad.easeIn);</pre></div>
  <p></p>
</div>
<a name="getSpice()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getSpice</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function getSpice(target:Object):<a href="../motion/PaprikaSpice.html">PaprikaSpice</a></code><p>
  Obtiene la instancia de PaprikaSpice asociada al objeto especificado.
  </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">target</span>:Object</code> &mdash; Un objeto del que obtener la especia.
  </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../motion/PaprikaSpice.html">PaprikaSpice</a></code> &mdash; 
                        La instancia asociada de PaprikaSpice. Si no tiene, retorna <code>null</code>.
  
                        
                     </td>
</tr>
</table>
</div>
<a name="isSpice()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">isSpice</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function isSpice(target:Object):Boolean</code><p>
  Comprueba si el objeto especificado tiene una animación creada con Paprika. Retorna <code>true</code> en caso afirmativo.
  </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">target</span>:Object</code> &mdash; Un objeto que se comparará con la lista interna de objetos animados.
  </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Boolean</code> &mdash; Un valor booleano.
  </td>
</tr>
</table>
</div>
<a name="remove()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">remove</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function remove(target:Object):void</code><p>
  Elimina y detiene la animación de una una especia de la lista de objetos interna.
  La instancia liberada es almacenada en el bote para su posterior reutilización.
  </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">target</span>:Object</code> &mdash; Objeto con animaciones a remover.
  </td>
</tr>
</table>
</div>
<a name="stop()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">stop</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function stop():void</code><p>
  Detiene todas las interpolaciones que se están ejecutando, eliminándolas de la lista de ejecución interna.
  También vacía la reserva de objetos, liberando la memoria.
  </p></div>
<a name="wait()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">wait</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function wait(target:Object, time:Number, delay:Number = 0, onComplete:Function = null, onCompleteParams:Array = null, scope:Object = null):<a href="../motion/PaprikaSpice.html">PaprikaSpice</a></code><p>
  Añade una especia con temporizador. No realiza ninguna interpolación sobre el objeto, únicamente invoca a la función <code>onComplete</code> cuando
  transcurre el tiempo especificado.
  </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">target</span>:Object</code> &mdash; Un objeto sobre el que aplicar el temporizador.
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">time</span>:Number</code> &mdash; La duración del temporizador, en segundos o fotogramas. Para poder utilizar un valor en fotogramas, el atributo
  <code>PaprikaSpice.useFrames</code> se ha de establecer en <code>true</code>.
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">delay</span>:Number</code> (default = <code>0</code>)<code></code> &mdash; Cantidad de retraso en segundos o fotogramas hasta que se inicie el temporizador.
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">onComplete</span>:Function</code> (default = <code>null</code>)<code></code> &mdash; Método que será invocado al finalizar el temporizador.
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">onCompleteParams</span>:Array</code> (default = <code>null</code>)<code></code> &mdash; Matriz con los parámetros a enviar a la función definida en <code>onComplete</code>.
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">scope</span>:Object</code> (default = <code>null</code>)<code></code> &mdash; Objeto al que se aplica la función definida en <code>onComplete</code>. Si no se especifica, se usará <code>target</code>.
  </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../motion/PaprikaSpice.html">PaprikaSpice</a></code></td>
</tr>
</table>
<br>
<span class="label">Example</span>
<br><div class='listing'><pre>import jp.raohmaru.motion.Paprika;<br>
Paprika.wait(this, 1, 0, function() :void
{
    //...
});</pre></div>
  <p></p>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright">http://www.raohmaru.com</center>
</div>
</body>
</html>
<!--http://www.raohmaru.com-->
